List Endpoint Status

Route

/v2/endpoints/list

Description

List endpoint status with enhanced filtering capabilities. This endpoint provides detailed status information about endpoints with advanced filtering options.

Method

POST

Inputs

Parameter	Type	Required	Description
filters	object	No	Filter criteria for endpoint status
page_size	integer	No	Number of results to return (max 100)
page_id	string	No	Page ID for pagination
sort_by	string	No	Field to sort by (name, status, last_seen)
sort_order	string	No	Sort order (asc, desc)

Filter Object

Parameter	Type	Required	Description
status	array[string]	No	Filter by endpoint status (online, offline, unknown)
platform	array[string]	No	Filter by platform (windows, macos, linux)
version	array[string]	No	Filter by sensor version
last_seen_after	string	No	Filter endpoints seen after this time (ISO 8601)
last_seen_before	string	No	Filter endpoints seen before this time (ISO 8601)

Request Body

{
  "filters": {
    "status": ["online", "offline"],
    "platform": ["windows", "macos"],
    "last_seen_after": "2024-01-01T00:00:00Z"
  },
  "page_size": 50,
  "sort_by": "last_seen",
  "sort_order": "desc"
}

Output

Field	Type	Description
resources	array[EndpointStatus]	Array of endpoint status objects
size	integer	Number of endpoints returned
next_page_id	string	Token for next page
errors	array[Error]	Any errors encountered

Endpoint Status Object

Field	Type	Description
id	string	Unique endpoint identifier
name	string	Endpoint name
status	string	Current status (online, offline, unknown)
platform	string	Operating system platform
version	string	Sensor version
last_seen	string	Last seen timestamp (ISO 8601)
ip_address	string	IP address
hostname	string	Hostname

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "resources": [
    {
      "id": "endpoint-123",
      "name": "DESKTOP-ABC123",
      "status": "online",
      "platform": "windows",
      "version": "25.04.1",
      "last_seen": "2024-01-15T10:30:00Z",
      "ip_address": "192.168.1.100",
      "hostname": "desktop-abc123.company.com"
    },
    {
      "id": "endpoint-456",
      "name": "MacBook-XYZ",
      "status": "offline",
      "platform": "macos",
      "version": "25.03.2",
      "last_seen": "2024-01-14T15:45:00Z",
      "ip_address": "192.168.1.101",
      "hostname": "macbook-xyz.company.com"
    }
  ],
  "size": 2,
  "next_page_id": "next_token_def456",
  "errors": []
}